Autocomplete #3484

ricardojlrufino · 2015-07-08T17:47:26Z

Working log

Autocomplete

(https://gist.github.com/ricardojlrufino/19f89884162be39d851a)

Indexing of Libraries Classes

 [*] Arduino Core (AVR)
    NOTE: I believe you need to make manual adjustments, remove some useless things and add other (eg contants HIGH, LOW)
          I'm not reading the #DEFINE for 'variables', because it will turn a mess.  
 [x] Multi Editor (many instances) support.
 [x] User Lib's(3rd-party libs)
 [x] Arduino Default Lib's
 [x] Inheritance Support  (Ex: Serial -> Stream -> Print)
 [ ] Index only the important files of libs (for now is taking all .h)

Autocomplete methods Classes

- [X] Instances
- [X] Static Classes
- [X] Pointer 
- [X] Get the parameters of methods
- [X] Auto-Complete using partial name method (contains!)
- [X] Order by type
- [x] Handle Struct
     [x] Handle static definition (Ex: EEPROM)
- [*] Handle extern (Ex: extern SPIClass SPI || extern EthernetClass Ethernet).
      [] Multiple alias Ex: Serial1, Serial2, etc...
- [*] '#define' statements 
      I'm not reading the #DEFINE for 'variables', because it will turn a mess. 
      NOTE: not parsing blocks like: "#if defined(UBRR1H) extern HardwareSerial Serial1;" in HardwareSerial.h    
  [*] Disable on External MODE.

Sketck - Autocomplete code being edited

  [x] Show only included Classes.
  [x] Show the variables of the current scope (use offset techniques)
     [x] Detect current function (based at the cursor location)
     [x] Update the position (offset) of the functions when the document is modified (new lines), without making the parser.
     |- NOTES:
     |- In Autocomplete they must appear first (deone).
     |- Not perfect, variables declared in blocks (if / while) are considered as function scope, to improve the performace
  [] Renaming / save as you must update the name in the Autocomplete Cache
     - have to remove the libraries that BEEN REMOVED (imports removed ..) ...
  [x] Parse source in-memory (do not need to save)
  [x] No show 'functions' outsite functions, only show classes
  [x] Detect custom variable names (EthernetClient client)
  [x] When you open the existing Sketch loads the autocomplete for the added LIBs
  [*] Parser in real time: 
      [x] Make the parser of changed line (ending with ';') and extract variables (and possibly errors).
      [x] Perform parse if you are changing a line with errors (syntax)
      [x] Perform parse if you are changing a line with errors (after compile)
      [x] Perform parse if you are changing a line with variable declararion.

      [] Enhancement: Parser current line using REXEX (for performance)
      - IMPL NOTE: For while it is being made a parser all code, is fast but could be better
                   The whole parser was necessary because i had to update the position (offset) of the methods in the document, 
                   but now this is already being done, I think a REGEX can be better    
      - NOTE: Only a parser(for same file) can run at the same time

[x] Async(Multi-tread) library parser... (based on Eclipse CDT AST Parser)
This is a external project: 'cplus-libparser', which can be used in other projects. ;)

[ ] Auto-Detect libraries dependency.
Related BUG: https://code.google.com/p/arduino/issues/detail?id=236
#2174

[x] Auto generate variable names (ALT + ENTER) inside a function call (Ex: digitalRead(var))
[x] After inserting into code, it must also appear in autocomplete

[*] Auto-Complete of the main functions parameters
Ex: Serial.begin({lista develocidades}), digitalWrite( {variables} , [HIGH / LOW])
[ ] This information should be captured from the source code (documentation)

[*] Show syntax(parser) error's
NOTE: need to be well tested, I did a few tests

[x] Autocomplete for #include pick up all the libraries;
NOTE: The window of the options just close with ESC or when you click with the MOUSE out, not close with TAB

[*] - Update LibraryIndex/Autocomplete on change libs of sketch
[x] Fire on Import from Menu
[ ] Fire on Import from ZIP.

[*] Store/Load parsed result in lib.index on each folder..
[ ] establish policies to update the index (LibraryChangeMonitor (only for h. files))
- How to deal with the upgrade of core libraries? must validate the version?
[x] You may want to implement a Serializer / Deserializer (NOTE:for now the index is binary )

[] Use 'javax.swing.text.Document' to parser, to avoid strings allocations
TODO: It has not been confirmed whether there is this problem. but I think so ...
Need implement: org.eclipse.cdt.internal.core.parser.scanner.AbstractCharArray

[x] Automatic adjustment of the position of the tooltip(completions window) to left or right

[] BUG(linux): The autocomplete window not working when you have another window "always on TOP"

[x] Autocomplete Shortcut's

dw,dr,aw,ar (digitalWrite, digitalRead, analogWrite, analogRead)
for,if,while,println

[x] Autocomplete of Sketch with multiple files
[x] BUG: When the SAVE event is launched cache and clean and only the modified classes are analyzed
[x] includes with global methods.
[x] includes with structs and static var.
[x] SyntaxErrorMarker - when a error occur, the highlight appear in two tabs
[x] #include - add other files of current Sketch in autocomplete for #include

[x] Compiler/SyntaxError - show multiple compiler erros at same time

[x] BUG - autocomplete cache/listeners problem on 'saveAs' sketch (It is keeping two versions)

[ ] Parse AVR Includes (/hardware/tools/avr/avr/include)
NOTE: At the moment I'm not sure which files should be done parser
PROBLEM: Including this autocomplete list can become large and confusing

access to Sketck information in the package 'core'

LastUndoableEditAwareUndoManager

this by using the appropriate fonts)

desktop (with SplashScreen) -Best ICON for Alt+TAB

Necessary in Linux to show the window name correctly

and improvements to the system undo / redo

changes in the position of 'setup'

Conflicts: app/src/processing/app/Base.java app/src/processing/app/Editor.java app/test/processing/app/helpers/ArduinoFrameFixture.java

analogWrite, analogRead)

…e-neweditor

…to 1.6.x-autocomplete-neweditor

Merge remote-tracking branch 'origin/1.6.x-autocomplete-neweditor' into 1.6.5-autocomplete New Fixes: [x] Autocomplete of Sketch with multiple files [x] BUG: When the SAVE event is launched cache and clean and only the modified classes are analyzed [x] includes with global methods. [x] includes with structs and static var. [x] SyntaxErrorMarker - when a error occur, the highlight appear in two tabs [x] #include - add other files of current Sketch in autocomplete for #include Conflicts: app/.classpath app/.classpath_vista app/run-linux.launch app/src/cc/arduino/packages/formatter/AStyle.java app/src/processing/app/Base.java app/src/processing/app/CaretAwareUndoableEdit.java app/src/processing/app/Editor.java app/src/processing/app/EditorLineStatus.java app/src/processing/app/EditorListener.java app/src/processing/app/Sketch.java app/src/processing/app/SketchCodeDocument.java app/src/processing/app/Theme.java app/src/processing/app/helpers/ConsoleLogger.java app/src/processing/app/helpers/LogFormatter.java app/src/processing/app/syntax/PdeKeywords.java app/src/processing/app/syntax/SketchTextArea.java app/src/processing/app/syntax/SketchTokenMaker.java app/test/processing/app/AutoformatSavesCaretPositionTest.java app/test/processing/app/AutoformatTest.java app/test/processing/app/BlockCommentGeneratesOneUndoActionTest.java app/test/processing/app/HittingEscapeOnCloseConfirmationDialogTest.java app/test/processing/app/ReduceIndentWith1CharOnLastLineTest.java app/test/processing/app/ReplacingTextGeneratesTwoUndoActionsTest.java app/test/processing/app/helpers/ArduinoFrameFixture.java app/test/processing/app/helpers/RSyntaxTextAreaComponentDriver.java arduino-core/.classpath arduino-core/src/processing/app/SketchData.java arduino-core/src/processing/app/debug/Compiler.java arduino-core/src/processing/app/helpers/StringUtils.java arduino-core/src/processing/app/helpers/filefilters/OnlyFilesWithExtension.java arduino-core/src/processing/app/packages/LibraryList.java build/build.xml build/linux/dist/arduino build/linux/dist/install.sh build/macosx/template.app/Contents/Info.plist build/shared/lib/theme/syntax/dark.xml build/shared/lib/theme/syntax/default.xml build/windows/dist/drivers/arduino.inf build/windows/launcher/config.xml build/windows/launcher/config_debug.xml libraries/Esplora/library.properties libraries/Ethernet/library.properties libraries/Firmata/library.properties libraries/LiquidCrystal/library.properties libraries/SD/library.properties libraries/SD/src/utility/Sd2Card.cpp libraries/Scheduler/library.properties libraries/Stepper/library.properties libraries/TFT/library.properties libraries/USBHost/library.properties

keeping two versions)

Chris--A · 2015-07-09T04:26:48Z

I saw the video of this a while ago and it looks really cool.
I would really like to try this out once the merge conflicts are resolved.

facchinm · 2017-11-13T12:39:44Z

Superseded by #6235

ricardojlrufino added 30 commits January 21, 2015 14:08

refactoring of Sketck class and creation of BaseSketck class allowing

0063898

access to Sketck information in the package 'core'

State of the buttons (UNDO / REDO) is now in

11f6eb0

LastUndoableEditAwareUndoManager

Trying to fix (unsuccessfully) support for the Japanese Input

4c83280

Removed old Japanese support files (perhaps the new java already support

83891fd

this by using the appropriate fonts)

[Linux] Installation Script that creates shortcuts on the menu and

13269a9

desktop (with SplashScreen) -Best ICON for Alt+TAB

Syntax highlighting Styles

b07d636

New Editor based on RSyntaxTextArea (for autocomplete and syntax errors)

0c466b0

Improved rendering of the name of the tabs

5834681

Arduino IDE Launcher class

0a2839e

Necessary in Linux to show the window name correctly

arduino-autocomplete module project

a181828

Refactoring sketche to support listeners, integration with autocomplete

12c6b14

and improvements to the system undo / redo

Listeners to monitor changes in sketches and in the active libraries

9b64e70

Classes for the Log control and some utility classes

00fc88a

Correction in REGEX doing parser of compilation errors (in LINUX)

3cc9157

small refactoring on PdePreprocessor

403133e

[Important] Added line in the beginning, to the autocomplete detect

3b8007a

changes in the position of 'setup'

Base - logs configuration and fix the icon on Linux

3a67523

Linux - improvements in the script to display icons correctly and spash

a7f6c51

Fixes in the build scripts for autocomplete module

9e196f1

improvement when adding items in autocomplete

0f0ba70

Rename class PdeTokenMarker to SketchTokenMaker

aaf4273

update lib cplus-libparser

2bc6da2

update arduino.desktop link

f5cc40f

update build .classpath

4f72737

remove unused imports

d5aa45e

Merge branch 'ide-1.5.x' into 1.6.x-autocomplete-neweditor

3641374

Conflicts: app/src/processing/app/Base.java app/src/processing/app/Editor.java app/test/processing/app/helpers/ArduinoFrameFixture.java

fix CTRL+'/' not working on Linux (with new Editor)

5d8c1f7

clean syntax errors before upload

9818577

completion shortcuts: dw,dr,aw,ar (digitalWrite, digitalRead,

2c9072e

analogWrite, analogRead)

openUrl - show message if file not exist

481e7ab

ricardojlrufino added 16 commits March 10, 2015 18:20

Open reference documentation using CONTROL + CLICK

6cbf93b

update lib cplus-libparser

73a647d

add LED_BUILTIN to autocomplete

bcdd420

Merge remote-tracking branch 'upstream/master' into 1.6.x-autocomplet…

0358bb6

…e-neweditor

remove java7 generic JList<?>

a4d48be

maintaining compatibility with Java 1.6

fb31607

Merge remote-tracking branch 'origin/1.6.x-autocomplete-neweditor' in…

22b6e4d

…to 1.6.x-autocomplete-neweditor

fix launcher depencencies for windows

0e85891

fix launcher depencencies for macosx - fixes #2

839c609

fix launcher depencencies for macosx - fixes #2

e53d775

Compiler/SyntaxError - show multiple compiler erros at same time

97088be

fixed - autocomplete cache/listeners problem on 'saveAs' sketch (It is

7b92cf0

keeping two versions)

fix eclipse classpath (add cplus-libparser-0.0.1)

a52a909

update Arduino.h, add param names and cplus-libparser jar

79eb524

refactoring - move ConsoleLogger to arduino-core

cdca07c

ffissore self-assigned this Jul 9, 2015

ffissore mentioned this pull request Nov 5, 2015

Provide code completion inside editor #4089

Closed

lmihalkovic mentioned this pull request Nov 5, 2015

Give some coolness factor to the ArduinoIDE #4084

Closed

cmaglie mentioned this pull request May 3, 2017

Base implementation of autocomplete #849 #6235

Closed

per1234 unassigned ffissore Jul 4, 2017

facchinm closed this Nov 13, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Autocomplete #3484

Autocomplete #3484

ricardojlrufino commented Jul 8, 2015

Chris--A commented Jul 9, 2015

facchinm commented Nov 13, 2017

Autocomplete #3484

Autocomplete #3484

Conversation

ricardojlrufino commented Jul 8, 2015

Autocomplete

Indexing of Libraries Classes

Autocomplete methods Classes

Sketck - Autocomplete code being edited

Chris--A commented Jul 9, 2015

facchinm commented Nov 13, 2017